<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
EscapingConventions.CrossLanguageStringXform (Soy Complete)
</TITLE>


<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="EscapingConventions.CrossLanguageStringXform (Soy Complete)";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.html" title="class in com.google.template.soy.shared.restricted"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.Escape.html" title="class in com.google.template.soy.shared.restricted"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="EscapingConventions.CrossLanguageStringXform.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.google.template.soy.shared.restricted</FONT>
<BR>
Class EscapingConventions.CrossLanguageStringXform</H2>
<PRE>
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>com.google.template.soy.shared.restricted.EscapingConventions.CrossLanguageStringXform</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html" title="interface in com.google.template.soy.internal.base">Escaper</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.EscapeCssString.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.EscapeCssString</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.EscapeHtml.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.EscapeHtml</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.EscapeHtmlNospace.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.EscapeHtmlNospace</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.EscapeJsRegex.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.EscapeJsRegex</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.EscapeJsString.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.EscapeJsString</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.EscapeUri.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.EscapeUri</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.FilterCssValue.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.FilterCssValue</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.FilterHtmlAttributes.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.FilterHtmlAttributes</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.FilterHtmlElementName.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.FilterHtmlElementName</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.FilterNormalizeUri.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.FilterNormalizeUri</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.NormalizeHtml.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.NormalizeHtml</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.NormalizeHtmlNospace.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.NormalizeHtmlNospace</A>, <A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.NormalizeUri.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.NormalizeUri</A></DD>
</DL>
<DL>
<DT><B>Enclosing class:</B><DD><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract static class <B>EscapingConventions.CrossLanguageStringXform</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html" title="interface in com.google.template.soy.internal.base">Escaper</A></DL>
</PRE>

<P>
A transformation on strings that preserves some correctness or safety properties.
 Subclasses come in three varieties:
 <dl>
   <dt>Escaper</dt>
     <dd>A mapping from strings in an input language to strings in an output language that
     preserves the content.
     E.g. the plain text string <code>1 &lt; 2</code> can be escaped to the equivalent HTML string
     <code>1 &amp;lt; 2</code>.</dd>
   <dt>Normalizer</dt>
     <dd>A mapping from strings in a language to equivalent strings in the same language but
     that can be more easily embedded in another language.
     E.g. the URI <code>http://www.google.com/search?q=O'Reilly</code> is equivalent to
     <code>http://www.google.com/search?q=O%27Reilly</code> but the latter can be safely
     embedded in a single quoted HTML attribute.</dd>
   <dt>Filter</dt>
     <dd>A mapping from strings in a language to the same value or to an innocuous value.
     E.g. the string <code>h1</code> might pass an html identifier filter but the string
     <code>&gt;&lt;script&gt;alert('evil')&lt;/script&gt;</code> should not and could be replaced by an innocuous
     value like <code>zzz</code>.</dd>
 </dl>
<P>

<P>
<HR>

<P>

<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#EscapingConventions.CrossLanguageStringXform(java.util.regex.Pattern, java.util.List, java.lang.String)">EscapingConventions.CrossLanguageStringXform</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</A>&nbsp;valueFilter,
                                             <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;? extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;jsNames,
                                             <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;nonAsciiPrefix)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected abstract &nbsp;com.google.common.collect.ImmutableList&lt;<A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.Escape.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.Escape</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#defineEscapes()">defineEscapes</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the escapes used for this escaper.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#escape(java.lang.Appendable)">escape</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</A>&nbsp;out)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an <code>Appendable</code> instance which automatically escapes all
 text appended to it before passing the resulting text to an underlying
 <code>Appendable</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#escape(java.lang.String)">escape</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;string)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the escaped form of a given literal string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#getDirectiveName()">getDirectiveName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the directive associated with this escaping function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;com.google.common.collect.ImmutableList&lt;<A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.Escape.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.Escape</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#getEscapes()">getEscapes</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The escapes need to translate the input language to the output language.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#getInnocuousOutput()">getInnocuousOutput</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an innocuous string in this context that can be used when filtering.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#getJsFunctionNames()">getJsFunctionNames</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The names of existing JavaScript builtins or Google Closure functions that implement
 the escaping convention.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#getNonAsciiPrefix()">getNonAsciiPrefix</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An escaping prefix in <code>"%", "\\u", "\\"</code> which specifies how to escape non-ASCII code
 units not in the sparse mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html#getValueFilter()">getValueFilter</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Null if the escaper accepts all strings as inputs, or otherwise a regular expression
 that accepts only strings that can be escaped by this escaper.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="EscapingConventions.CrossLanguageStringXform(java.util.regex.Pattern, java.util.List, java.lang.String)"><!-- --></A><H3>
EscapingConventions.CrossLanguageStringXform</H3>
<PRE>
protected <B>EscapingConventions.CrossLanguageStringXform</B>(<FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
                                                       <A HREF="http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</A>&nbsp;valueFilter,
                                                       <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;? extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;jsNames,
                                                       <FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
                                                       <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;nonAsciiPrefix)</PRE>
<DL>
<DL>
<DT><B>Parameters:</B><DD><CODE>valueFilter</CODE> - <code>null</code> if the directive accepts all strings as inputs.  Otherwise
     a regular expression that accepts only strings that can be escaped by this directive.<DD><CODE>jsNames</CODE> - The names of existing JavaScript builtins or Google Closure functions, if
     any exist, that implements this escaping convention.<DD><CODE>nonAsciiPrefix</CODE> - An escaping prefix in <code>"%", "\\u", "\\"</code> which specifies how to
     escape non-ASCII code units not in the sparse mapping.
     If null, then non-ASCII code units outside the sparse map can appear unescaped.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="defineEscapes()"><!-- --></A><H3>
defineEscapes</H3>
<PRE>
protected abstract com.google.common.collect.ImmutableList&lt;<A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.Escape.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.Escape</A>&gt; <B>defineEscapes</B>()</PRE>
<DL>
<DD>Returns the escapes used for this escaper.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getDirectiveName()"><!-- --></A><H3>
getDirectiveName</H3>
<PRE>
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDirectiveName</B>()</PRE>
<DL>
<DD>The name of the directive associated with this escaping function.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>E.g. <code>|escapeHtml</code></DL>
</DD>
</DL>
<HR>

<A NAME="getNonAsciiPrefix()"><!-- --></A><H3>
getNonAsciiPrefix</H3>
<PRE>
<FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A>
</FONT>public final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getNonAsciiPrefix</B>()</PRE>
<DL>
<DD>An escaping prefix in <code>"%", "\\u", "\\"</code> which specifies how to escape non-ASCII code
 units not in the sparse mapping.
 If null, then non-ASCII code units outside the sparse map can appear unescaped.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getValueFilter()"><!-- --></A><H3>
getValueFilter</H3>
<PRE>
<FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A>
</FONT>public final <A HREF="http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</A> <B>getValueFilter</B>()</PRE>
<DL>
<DD>Null if the escaper accepts all strings as inputs, or otherwise a regular expression
 that accepts only strings that can be escaped by this escaper.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getJsFunctionNames()"><!-- --></A><H3>
getJsFunctionNames</H3>
<PRE>
public final <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt; <B>getJsFunctionNames</B>()</PRE>
<DL>
<DD>The names of existing JavaScript builtins or Google Closure functions that implement
 the escaping convention.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>null</code> if there is no such function.</DL>
</DD>
</DL>
<HR>

<A NAME="getEscapes()"><!-- --></A><H3>
getEscapes</H3>
<PRE>
public final com.google.common.collect.ImmutableList&lt;<A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.Escape.html" title="class in com.google.template.soy.shared.restricted">EscapingConventions.Escape</A>&gt; <B>getEscapes</B>()</PRE>
<DL>
<DD>The escapes need to translate the input language to the output language.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getInnocuousOutput()"><!-- --></A><H3>
getInnocuousOutput</H3>
<PRE>
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getInnocuousOutput</B>()</PRE>
<DL>
<DD>Returns an innocuous string in this context that can be used when filtering.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="escape(java.lang.String)"><!-- --></A><H3>
escape</H3>
<PRE>
public final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>escape</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;string)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html#escape(java.lang.String)">Escaper</A></CODE></B></DD>
<DD>Returns the escaped form of a given literal string.

 <p>Note that this method may treat input characters differently depending
 on the specific escaper implementation.
 <ul>
 <li><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html" title="class in com.google.template.soy.internal.base"><CODE>UnicodeEscaper</CODE></A> handles
 <a href="http://en.wikipedia.org/wiki/UTF-16">UTF-16</a> correctly,
 including surrogate character pairs. If the input is badly formed the
 escaper should throw <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A>.
 <li><A HREF="../../../../../../com/google/template/soy/internal/base/CharEscaper.html" title="class in com.google.template.soy.internal.base"><CODE>CharEscaper</CODE></A> handles Java characters independently and does not
 verify the input for well formed characters. A CharEscaper should not be
 used in situations where input is not guaranteed to be restricted to the
 Basic Multilingual Plane (BMP).
 </ul>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html#escape(java.lang.String)">escape</A></CODE> in interface <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html" title="interface in com.google.template.soy.internal.base">Escaper</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>string</CODE> - the literal string to be escaped
<DT><B>Returns:</B><DD>the escaped form of <code>string</code></DL>
</DD>
</DL>
<HR>

<A NAME="escape(java.lang.Appendable)"><!-- --></A><H3>
escape</H3>
<PRE>
public final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</A> <B>escape</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</A>&nbsp;out)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html#escape(java.lang.Appendable)">Escaper</A></CODE></B></DD>
<DD>Returns an <code>Appendable</code> instance which automatically escapes all
 text appended to it before passing the resulting text to an underlying
 <code>Appendable</code>.

 <p>Note that the Appendable returned by this method may treat input
 characters differently depending on the specific escaper implementation.
 <ul>
 <li><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html" title="class in com.google.template.soy.internal.base"><CODE>UnicodeEscaper</CODE></A> handles
 <a href="http://en.wikipedia.org/wiki/UTF-16">UTF-16</a> correctly,
 including surrogate character pairs. If the input is badly formed the
 escaper should throw <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A>.
 <li><A HREF="../../../../../../com/google/template/soy/internal/base/CharEscaper.html" title="class in com.google.template.soy.internal.base"><CODE>CharEscaper</CODE></A> handles Java characters independently and does not
 verify the input for well formed characters. A CharEscaper should not be
 used in situations where input is not guaranteed to be restricted to the
 Basic Multilingual Plane (BMP).
 </ul>

 <p>In all implementations the escaped Appendable should throw
 <code>NullPointerException</code> if given a <code>null</code> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang"><CODE>CharSequence</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html#escape(java.lang.Appendable)">escape</A></CODE> in interface <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html" title="interface in com.google.template.soy.internal.base">Escaper</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - the underlying <code>Appendable</code> to append escaped output to
<DT><B>Returns:</B><DD>an <code>Appendable</code> which passes text to <code>out</code> after
     escaping it.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.html" title="class in com.google.template.soy.shared.restricted"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../com/google/template/soy/shared/restricted/EscapingConventions.Escape.html" title="class in com.google.template.soy.shared.restricted"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?com/google/template/soy/shared/restricted/EscapingConventions.CrossLanguageStringXform.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="EscapingConventions.CrossLanguageStringXform.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

        
          <div id="footer">
            <div id="footerlogo" style="float:left">
              <img src="http://www.google.com/images/art.gif"
                   alt="Google colored balls">
            </div>
            <div id="copyright" style="float:left">
              <p>
                &copy; 2009 Google -
                <a href="http://www.google.com/privacy.html">Privacy Policy</a> -
                <a href="http://www.google.com/terms_of_service.html">Terms and Conditions</a> -
                <a href="http://www.google.com/about.html">About Google</a>
              </p>
            </div>
          </div>
        
      
</BODY>
</HTML>
